Node / meshtastic / Meshtastic-Android / files / feature / docs / src / commonMain / kotlin / org / meshtastic / feature / docs / translation / DocTranslationCache.kt

Displaying Raw • Download

T8b949e/*

* Copyright (c) 2026 Meshtastic LLC

*

* This program is free software: you can redistribute it and/or modify

* it under the terms of the GNU General Public License as published by

* the Free Software Foundation, either version 3 of the License, or

* (at your option) any later version.

*

* This program is distributed in the hope that it will be useful,

* but WITHOUT ANY WARRANTY; without even the implied warranty of

* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

* GNU General Public License for more details.

*

* You should have received a copy of the GNU General Public License

* along with this program. If not, see <https://www.gnu.org/licenses/>.

*/

Tff7b72package T7ee787org.meshtastic.feature.docs.translation

Tff7b72import T7ee787co.touchlab.kermit.Logger

Tff7b72import T7ee787kotlinx.coroutines.sync.Mutex

Tff7b72import T7ee787kotlinx.coroutines.sync.withLock

Tff7b72import T7ee787okio.FileSystem

Tff7b72import T7ee787okio.IOException

Tff7b72import T7ee787okio.Path

Tff7b72import T7ee787okio.Path.Companion.toPath

Tff7b72import T7ee787okio.buffer

T8b949e/**

* File-based cache for ML Kit translated markdown pages.

*

* Cache key: `{pageId}#{locale}#{md5(sourceContent)}` When the English source changes, the md5 changes and the old

* cache entry becomes stale. Eviction by oldest-access at [maxCacheSizeBytes] (default 50MB).

*/

Tff7b72class T56d364DocTranslationCacheTb4b4b4(

Tff7b72private Tff7b72val Te6edf3cacheDirTb4b4b4: Te6edf3PathTb4b4b4,

Tff7b72private Tff7b72val Te6edf3fileSystemTb4b4b4: Te6edf3FileSystemTb4b4b4,

Tff7b72private Tff7b72val Te6edf3maxCacheSizeBytesTb4b4b4: Tffa657Long Tff7b72= Te6edf3MAX_CACHE_SIZE_BYTESTb4b4b4,

Tb4b4b4) Tb4b4b4{

Tff7b72companion Tff7b72object Tb4b4b4{

Tff7b72const Tff7b72val Te6edf3MAX_CACHE_SIZE_BYTES Tff7b72= T79c0ff5T79c0ff0L Tff7b72* T79c0ff1T79c0ff0T79c0ff2T79c0ff4 Tff7b72* T79c0ff1T79c0ff0T79c0ff2T79c0ff4 T8b949e// 50 MB

Tff7b72private Tff7b72const Tff7b72val Te6edf3CACHE_SUBDIR Tff7b72= Ta5d6ff"Ta5d6ffdocs_translation_cacheTa5d6ff"

Tff7b72private Tff7b72const Tff7b72val Te6edf3EVICTION_TARGET_PERCENT Tff7b72= T79c0ff7T79c0ff5

Tff7b72private Tff7b72const Tff7b72val Te6edf3PERCENT_DIVISOR Tff7b72= T79c0ff1T79c0ff0T79c0ff0

Tff7b72private Tff7b72const Tff7b72val Te6edf3TAG Tff7b72= Ta5d6ff"Ta5d6ffDocTranslationCacheTa5d6ff"

Tb4b4b4}

Tff7b72private Tff7b72val Te6edf3mutex Tff7b72= Te6edf3MutexTb4b4b4(Tb4b4b4)

Tff7b72private Tff7b72val Te6edf3cacheRootTb4b4b4: Te6edf3Path

Tff7b72getTb4b4b4(Tb4b4b4) Tff7b72= Te6edf3cacheDir Tff7b72/ Te6edf3CACHE_SUBDIR

T8b949e/** Get a cached translation, or null if not cached or stale. */

Tff7b72suspend Tff7b72fun Td2a8ffgetTb4b4b4(Te6edf3pageIdTb4b4b4: Tffa657StringTb4b4b4, Te6edf3localeTb4b4b4: Tffa657StringTb4b4b4, Te6edf3sourceHashTb4b4b4: Tffa657StringTb4b4b4)Tb4b4b4: Tffa657String? Tff7b72= Te6edf3mutexTb4b4b4.Te6edf3withLock Tb4b4b4{

Tff7b72val Te6edf3file Tff7b72= Te6edf3cacheFileTb4b4b4(Te6edf3pageIdTb4b4b4, Te6edf3localeTb4b4b4, Te6edf3sourceHashTb4b4b4)

Tff7b72try Tb4b4b4{

Tff7b72if Tb4b4b4(Te6edf3fileSystemTb4b4b4.Te6edf3existsTb4b4b4(Te6edf3fileTb4b4b4)Tb4b4b4) Tb4b4b4{

Tff7b72val Te6edf3bufferedSource Tff7b72= Te6edf3fileSystemTb4b4b4.Te6edf3sourceTb4b4b4(Te6edf3fileTb4b4b4)Tb4b4b4.Te6edf3bufferTb4b4b4(Tb4b4b4)

Tff7b72val Te6edf3content Tff7b72= Te6edf3bufferedSourceTb4b4b4.Te6edf3readUtf8Tb4b4b4(Tb4b4b4)

Te6edf3bufferedSourceTb4b4b4.Te6edf3closeTb4b4b4(Tb4b4b4)

T8b949e// Touch file to update access time for eviction ordering

Te6edf3touchFileTb4b4b4(Te6edf3fileTb4b4b4)

Te6edf3content

Tb4b4b4} Tff7b72else Tb4b4b4{

Tff7b72null

Tb4b4b4}

Tb4b4b4} Tff7b72catch Tb4b4b4(Te6edf3eTb4b4b4: Te6edf3IOExceptionTb4b4b4) Tb4b4b4{

Te6edf3LoggerTb4b4b4.Te6edf3wTb4b4b4(Te6edf3tag Tff7b72= Te6edf3TAGTb4b4b4) Tb4b4b4{ Ta5d6ff"Ta5d6ffCache read failed for Tffd700$Te6edf3pageIdTa5d6ff/Tffd700$Te6edf3localeTa5d6ff: Tffd700${Te6edf3eTb4b4b4.Te6edf3messageTffd700}Ta5d6ff" Tb4b4b4}

Tff7b72null

Tb4b4b4}

Tb4b4b4}

T8b949e/** Store a translated page in the cache. Evicts old entries if over size limit. */

Tff7b72suspend Tff7b72fun Td2a8ffputTb4b4b4(Te6edf3pageIdTb4b4b4: Tffa657StringTb4b4b4, Te6edf3localeTb4b4b4: Tffa657StringTb4b4b4, Te6edf3sourceHashTb4b4b4: Tffa657StringTb4b4b4, Te6edf3translatedMarkdownTb4b4b4: Tffa657StringTb4b4b4) Tff7b72= Te6edf3mutexTb4b4b4.Te6edf3withLock Tb4b4b4{

Tff7b72try Tb4b4b4{

Te6edf3fileSystemTb4b4b4.Te6edf3createDirectoriesTb4b4b4(Te6edf3cacheRootTb4b4b4)

Tff7b72val Te6edf3file Tff7b72= Te6edf3cacheFileTb4b4b4(Te6edf3pageIdTb4b4b4, Te6edf3localeTb4b4b4, Te6edf3sourceHashTb4b4b4)

T8b949e// Write to temp file then move for atomicity

Tff7b72val Te6edf3tmpFile Tff7b72= Te6edf3cacheRoot Tff7b72/ Ta5d6ff"Tffd700${Te6edf3fileTb4b4b4.Te6edf3nameTffd700}Ta5d6ff.tmpTa5d6ff"

Tff7b72val Te6edf3bufferedSink Tff7b72= Te6edf3fileSystemTb4b4b4.Te6edf3sinkTb4b4b4(Te6edf3tmpFileTb4b4b4)Tb4b4b4.Te6edf3bufferTb4b4b4(Tb4b4b4)

Te6edf3bufferedSinkTb4b4b4.Te6edf3writeUtf8Tb4b4b4(Te6edf3translatedMarkdownTb4b4b4)

Te6edf3bufferedSinkTb4b4b4.Te6edf3closeTb4b4b4(Tb4b4b4)

Te6edf3fileSystemTb4b4b4.Te6edf3atomicMoveTb4b4b4(Te6edf3tmpFileTb4b4b4, Te6edf3fileTb4b4b4)

Te6edf3evictIfNeededTb4b4b4(Tb4b4b4)

Tb4b4b4} Tff7b72catch Tb4b4b4(Te6edf3eTb4b4b4: Te6edf3IOExceptionTb4b4b4) Tb4b4b4{

Te6edf3LoggerTb4b4b4.Te6edf3wTb4b4b4(Te6edf3tag Tff7b72= Te6edf3TAGTb4b4b4) Tb4b4b4{ Ta5d6ff"Ta5d6ffCache write failed for Tffd700$Te6edf3pageIdTa5d6ff/Tffd700$Te6edf3localeTa5d6ff: Tffd700${Te6edf3eTb4b4b4.Te6edf3messageTffd700}Ta5d6ff" Tb4b4b4}

Tb4b4b4}

Tb4b4b4}

T8b949e/** Remove all cached translations. */

Tff7b72suspend Tff7b72fun Td2a8ffclearTb4b4b4(Tb4b4b4) Tff7b72= Te6edf3mutexTb4b4b4.Te6edf3withLock Tb4b4b4{

Tff7b72try Tb4b4b4{

Tff7b72if Tb4b4b4(Te6edf3fileSystemTb4b4b4.Te6edf3existsTb4b4b4(Te6edf3cacheRootTb4b4b4)Tb4b4b4) Tb4b4b4{

Te6edf3fileSystemTb4b4b4.Te6edf3deleteRecursivelyTb4b4b4(Te6edf3cacheRootTb4b4b4)

Tb4b4b4}

Tb4b4b4} Tff7b72catch Tb4b4b4(Te6edf3eTb4b4b4: Te6edf3IOExceptionTb4b4b4) Tb4b4b4{

Te6edf3LoggerTb4b4b4.Te6edf3wTb4b4b4(Te6edf3tag Tff7b72= Te6edf3TAGTb4b4b4) Tb4b4b4{ Ta5d6ff"Ta5d6ffCache clear failed: Tffd700${Te6edf3eTb4b4b4.Te6edf3messageTffd700}Ta5d6ff" Tb4b4b4}

Tb4b4b4}

Tb4b4b4}

T8b949e/** Total bytes used by the cache. */

Tff7b72suspend Tff7b72fun Td2a8ffsizeBytesTb4b4b4(Tb4b4b4)Tb4b4b4: Tffa657Long Tff7b72= Te6edf3mutexTb4b4b4.Te6edf3withLock Tb4b4b4{ Te6edf3sizeBytesInternalTb4b4b4(Tb4b4b4) Tb4b4b4}

Tff7b72private Tff7b72fun Td2a8ffsizeBytesInternalTb4b4b4(Tb4b4b4)Tb4b4b4: Tffa657Long Tff7b72= Tff7b72try Tb4b4b4{

Tff7b72if Tb4b4b4(Tff7b72!Te6edf3fileSystemTb4b4b4.Te6edf3existsTb4b4b4(Te6edf3cacheRootTb4b4b4)Tb4b4b4) Tff7b72return T79c0ff0L

Te6edf3fileSystem

Tb4b4b4.Te6edf3listRecursivelyTb4b4b4(Te6edf3cacheRootTb4b4b4)

Tb4b4b4.Te6edf3filter Tb4b4b4{ Te6edf3fileSystemTb4b4b4.Te6edf3metadataTb4b4b4(Tffa657itTb4b4b4)Tb4b4b4.Te6edf3isRegularFile Tb4b4b4}

Tb4b4b4.Te6edf3filter Tb4b4b4{ Tffa657itTb4b4b4.Te6edf3nameTb4b4b4.Te6edf3endsWithTb4b4b4(Ta5d6ff"Ta5d6ff.mdTa5d6ff"Tb4b4b4) Tb4b4b4}

Tb4b4b4.Te6edf3sumOf Tb4b4b4{ Te6edf3fileSystemTb4b4b4.Te6edf3metadataTb4b4b4(Tffa657itTb4b4b4)Tb4b4b4.Te6edf3size Tff7b72?: T79c0ff0L Tb4b4b4}

Tb4b4b4} Tff7b72catch Tb4b4b4(Te6edf3eTb4b4b4: Te6edf3IOExceptionTb4b4b4) Tb4b4b4{

Te6edf3LoggerTb4b4b4.Te6edf3wTb4b4b4(Te6edf3tag Tff7b72= Te6edf3TAGTb4b4b4) Tb4b4b4{ Ta5d6ff"Ta5d6ffCache size calculation failed: Tffd700${Te6edf3eTb4b4b4.Te6edf3messageTffd700}Ta5d6ff" Tb4b4b4}

T79c0ff0L

Tb4b4b4}

Tff7b72private Tff7b72fun Td2a8fftouchFileTb4b4b4(Te6edf3fileTb4b4b4: Te6edf3PathTb4b4b4) Tb4b4b4{

T8b949e// Write a tiny sidecar file to track last access time for eviction ordering.

T8b949e// The sidecar's own mtime serves as the access timestamp.

Tff7b72try Tb4b4b4{

Tff7b72val Te6edf3accessFile Tff7b72= Ta5d6ff"Tffd700$Te6edf3fileTa5d6ff.accessTa5d6ff"Tb4b4b4.Te6edf3toPathTb4b4b4(Tb4b4b4)

Tff7b72val Te6edf3sink Tff7b72= Te6edf3fileSystemTb4b4b4.Te6edf3sinkTb4b4b4(Te6edf3accessFileTb4b4b4)Tb4b4b4.Te6edf3bufferTb4b4b4(Tb4b4b4)

Te6edf3sinkTb4b4b4.Te6edf3writeUtf8Tb4b4b4(Ta5d6ff"Ta5d6ff1Ta5d6ff"Tb4b4b4)

Te6edf3sinkTb4b4b4.Te6edf3closeTb4b4b4(Tb4b4b4)

Tb4b4b4} Tff7b72catch Tb4b4b4(Te6edf3_Tb4b4b4: Te6edf3IOExceptionTb4b4b4) Tb4b4b4{

T8b949e// Non-fatal: eviction order may be slightly off

Tb4b4b4}

Tb4b4b4}

Tff7b72private Tff7b72fun Td2a8ffcacheFileTb4b4b4(Te6edf3pageIdTb4b4b4: Tffa657StringTb4b4b4, Te6edf3localeTb4b4b4: Tffa657StringTb4b4b4, Te6edf3sourceHashTb4b4b4: Tffa657StringTb4b4b4)Tb4b4b4: Te6edf3Path Tb4b4b4{

Tff7b72val Te6edf3safeKey Tff7b72= Ta5d6ff"Tffd700${Te6edf3pageIdTffd700}Ta5d6ff_Tffd700${Te6edf3localeTffd700}Ta5d6ff_Tffd700$Te6edf3sourceHashTa5d6ff"Tb4b4b4.Te6edf3replaceTb4b4b4(Te6edf3RegexTb4b4b4(Ta5d6ff"Ta5d6ff[^a-zA-Z0-9_-]Ta5d6ff"Tb4b4b4)Tb4b4b4, Ta5d6ff"Ta5d6ff_Ta5d6ff"Tb4b4b4)

Tff7b72return Te6edf3cacheRoot Tff7b72/ Ta5d6ff"Tffd700$Te6edf3safeKeyTa5d6ff.mdTa5d6ff"

Tb4b4b4}

Tff7b72private Tff7b72fun Td2a8ffevictIfNeededTb4b4b4(Tb4b4b4) Tb4b4b4{

Tff7b72if Tb4b4b4(Te6edf3sizeBytesInternalTb4b4b4(Tb4b4b4) Tff7b72<Tff7b72= Te6edf3maxCacheSizeBytesTb4b4b4) Tff7b72return

Tff7b72try Tb4b4b4{

Tff7b72val Te6edf3files Tff7b72=

Te6edf3fileSystem

Tb4b4b4.Te6edf3listRecursivelyTb4b4b4(Te6edf3cacheRootTb4b4b4)

Tb4b4b4.Te6edf3filter Tb4b4b4{ Te6edf3fileSystemTb4b4b4.Te6edf3metadataTb4b4b4(Tffa657itTb4b4b4)Tb4b4b4.Te6edf3isRegularFile Tb4b4b4}

Tb4b4b4.Te6edf3filter Tb4b4b4{ Tffa657itTb4b4b4.Te6edf3nameTb4b4b4.Te6edf3endsWithTb4b4b4(Ta5d6ff"Ta5d6ff.mdTa5d6ff"Tb4b4b4) Tb4b4b4}

Tb4b4b4.Te6edf3sortedBy Tb4b4b4{ Te6edf3file Tff7b72-Tff7b72>

T8b949e// Use sidecar access file mtime if available, else cache file mtime

Tff7b72val Te6edf3accessFile Tff7b72= Ta5d6ff"Tffd700$Te6edf3fileTa5d6ff.accessTa5d6ff"Tb4b4b4.Te6edf3toPathTb4b4b4(Tb4b4b4)

Tff7b72if Tb4b4b4(Te6edf3fileSystemTb4b4b4.Te6edf3existsTb4b4b4(Te6edf3accessFileTb4b4b4)Tb4b4b4) Tb4b4b4{

Te6edf3fileSystemTb4b4b4.Te6edf3metadataTb4b4b4(Te6edf3accessFileTb4b4b4)Tb4b4b4.Te6edf3lastModifiedAtMillis Tff7b72?: T79c0ff0L

Tb4b4b4} Tff7b72else Tb4b4b4{

Te6edf3fileSystemTb4b4b4.Te6edf3metadataTb4b4b4(Te6edf3fileTb4b4b4)Tb4b4b4.Te6edf3lastModifiedAtMillis Tff7b72?: T79c0ff0L

Tb4b4b4}

Tb4b4b4}

Tb4b4b4.Te6edf3toListTb4b4b4(Tb4b4b4)

Tff7b72var Te6edf3currentSize Tff7b72= Te6edf3sizeBytesInternalTb4b4b4(Tb4b4b4)

Tff7b72for Tb4b4b4(Te6edf3file Tff7b72in Te6edf3filesTb4b4b4) Tb4b4b4{

Tff7b72if Tb4b4b4(Te6edf3currentSize Tff7b72<Tff7b72= Te6edf3maxCacheSizeBytes Tff7b72* Te6edf3EVICTION_TARGET_PERCENT Tff7b72/ Te6edf3PERCENT_DIVISORTb4b4b4) Tff7b72break

Tff7b72val Te6edf3fileSize Tff7b72= Te6edf3fileSystemTb4b4b4.Te6edf3metadataTb4b4b4(Te6edf3fileTb4b4b4)Tb4b4b4.Te6edf3size Tff7b72?: T79c0ff0L

Te6edf3fileSystemTb4b4b4.Te6edf3deleteTb4b4b4(Te6edf3fileTb4b4b4)

T8b949e// Also delete sidecar access file

Tff7b72val Te6edf3accessFile Tff7b72= Ta5d6ff"Tffd700$Te6edf3fileTa5d6ff.accessTa5d6ff"Tb4b4b4.Te6edf3toPathTb4b4b4(Tb4b4b4)

Tff7b72try Tb4b4b4{

Te6edf3fileSystemTb4b4b4.Te6edf3deleteTb4b4b4(Te6edf3accessFileTb4b4b4)

Tb4b4b4} Tff7b72catch Tb4b4b4(Te6edf3_Tb4b4b4: Te6edf3IOExceptionTb4b4b4) Tb4b4b4{

T8b949e/* ignore */

Tb4b4b4}

Te6edf3currentSize Tff7b72-Tff7b72= Te6edf3fileSize

Tb4b4b4}

Tb4b4b4} Tff7b72catch Tb4b4b4(Te6edf3eTb4b4b4: Te6edf3IOExceptionTb4b4b4) Tb4b4b4{

Te6edf3LoggerTb4b4b4.Te6edf3wTb4b4b4(Te6edf3tag Tff7b72= Te6edf3TAGTb4b4b4) Tb4b4b4{ Ta5d6ff"Ta5d6ffCache eviction failed: Tffd700${Te6edf3eTb4b4b4.Te6edf3messageTffd700}Ta5d6ff" Tb4b4b4}

Tb4b4b4}

Tb4b4b4}

Tb4b4b4}

T8b949e/** Simple MD5 hash for cache key generation. Uses Okio's built-in hashing. */

Tff7b72fun Td2a8ffmd5HashTb4b4b4(Te6edf3contentTb4b4b4: Tffa657StringTb4b4b4)Tb4b4b4: Tffa657String Tb4b4b4{

Tff7b72val Te6edf3buffer Tff7b72= Te6edf3okioTb4b4b4.Te6edf3BufferTb4b4b4(Tb4b4b4)

Te6edf3bufferTb4b4b4.Te6edf3writeUtf8Tb4b4b4(Te6edf3contentTb4b4b4)

Tff7b72return Te6edf3bufferTb4b4b4.Te6edf3md5Tb4b4b4(Tb4b4b4)Tb4b4b4.Te6edf3hexTb4b4b4(Tb4b4b4)

Tb4b4b4}